Hist - Alarms Data Group
The "Hist - Alarms" (HistAlarm) data group is used to read alarms from the Emerson event file. The data group reads by date range, index number, or get latest data.
Get latest data: There are three different parameters associated with a Get latest data request, each of which may be combined with the others for different effects:
- Max records to read: Specifies the maximum number of historical records to retrieve.
- Start date: Specifies the oldest date limit. If there is no cached "last record," reading will begin at the indicated start date. If the "last record" has been cached, the start time will be used only if it is later than the cached record time.
- End date: Specifies the most recent date limit.
Get data by index: There are two parameters associated with this selection:
- Starting record index: The number of the record index to start polling from.
- Max records to read: Specifies the maximum number of historical records to retrieve.
Get data by date range: There are two parameters associated with this selection:
- Start date: Specifies the oldest date limit.
- End date: Specifies the most recent date limit.
Example
 Click here to see an example of the data group
<HistAlarm niceName="Hist - Alarms"> <dgElements secLev="4" type="vrnt"> <Count desc="Event count"/> <DateTime desc="Timestamp"/> <RecVers desc="Rec version" hidden="true"/> <Seq desc="Seq #"/> <RecType desc="Type #" hidden="true"/> <RecTypeT desc="Type" type="string" ref="RecType" mapVal="U106AlmType"/> <SubType desc="Sub- type #" hidden="true"/> <SubTypeT desc="Sub-type" type="string" isRef="1"> <ref prec="0" refOp="opAssignId" deid="SubType"/> <ref prec="1" refOp="opMapToMapVal" deid="RecType" mapVal="MapAlmType"/> </SubTypeT> <Tag desc="Parameter"/> <DataType desc="Data type #" hidden="true"/> <DataTypeT desc="Data type" type="string" hidden="true" ref="DataType" mapVal="EDataType"/> <Value desc="Value"/> <MeasType desc="Meas type #" hidden="true"/> <UnitType desc="Unit type #" hidden="true"/> <Units desc="Units"/> <Direction desc="Direction #" hidden="true"/> <DirectionT desc="Direction" type="string" ref="Direction" mapVal="U101AlmDir"/> <Group desc="Group" hidden="true"/> <Priority desc="Priority" hidden="true"/> <Desc desc="Description"/> </dgElements> <uccRecvParms required="false"> <Cnt desc="Max records to read" type="ui4"/> <GetLatest desc="Get latest?" type="boolean"/> <Seq desc="Sequence #" type="ui4"/> <SDate desc="Start date" type="string"/> <EDate desc="End date" type="string"/> </uccRecvParms> </HistAlarm> |
